feat: Add performance metrics for signature requests #26967

OGPoyraz · 2024-09-06T13:27:30Z

Description

Adds Signature traces
Wraps newUnsignedTypedMessage in a utility function, adds end of Middleware trace and Signature trace after hash is returned from background.

Note that this PR still using a preview will be updated once core is released.

Related issues

Fixes: https://github.com/MetaMask/MetaMask-planning/issues/2902

Manual testing steps

No QA needed.

Screenshots/Recordings

An example Sentry trace for Signature https://metamask.sentry.io/performance/trace/53446691f4d44d40a5f9de82f1cebd05/?fov=0%2C4381.00004196167&node=txn-d4053774d6c2495b8564fdce1fac8bec&pageEnd&pageStart&project=273496&source=traces&statsPeriod=15m&timestamp=1725629491.052

Before

After

Pre-merge author checklist

I've followed MetaMask Contributor Docs and MetaMask Extension Coding Standards.
I've completed the PR template to the best of my ability
I’ve included tests if applicable
I’ve documented my code using JSDoc format if applicable
I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

socket-security · 2024-09-06T13:28:29Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

View full report↗︎

…ntation

app/scripts/lib/createTracingMiddleware.ts

ui/pages/confirmations/confirm-transaction/confirm-transaction.component.js

shared/lib/trace.ts

app/scripts/metamask-controller.js

app/scripts/lib/signature/util.ts

app/scripts/lib/createTracingMiddleware.ts

app/scripts/metamask-controller.js

app/scripts/lib/signature/util.ts

package.json

…ntation

socket-security · 2024-09-17T07:47:09Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/[email protected]	None	`0`	184 kB	metamaskbot

🚮 Removed packages: npm/@metamask/[email protected]

View full report↗︎

…ntation

sonarqubecloud · 2024-09-18T10:45:17Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

…ntation

metamaskbot · 2024-09-23T09:16:30Z

Builds ready [2d743ac]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1860 ± 65 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1606	2172	1857	140	67
		domContentLoaded	1597	2119	1828	131	63
		load	1606	2174	1860	135	65
		domInteractive	15	190	45	36	17

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 2.3 KiB (0.06%)
ui: 182 Bytes (0.00%)
common: 201 Bytes (0.00%)

package.json

Co-authored-by: Vinicius Stevam <[email protected]>

metamaskbot · 2024-09-24T14:22:52Z

Builds ready [f08fdb2]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (2036 ± 118 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	237	2593	1941	462	222
		domContentLoaded	1727	2548	1987	234	112
		load	1737	2592	2036	246	118
		domInteractive	15	63	34	12	6

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 2.3 KiB (0.06%)
ui: 182 Bytes (0.00%)
common: 201 Bytes (0.00%)

…ntation

sonarqubecloud · 2024-09-26T08:32:16Z

Quality Gate failed

Failed conditions
65.2% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud

metamaskbot · 2024-09-26T08:52:37Z

Builds ready [5ccb223]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1862 ± 92 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1676	2342	1861	194	93
		domContentLoaded	1667	2299	1837	189	91
		load	1689	2347	1862	192	92
		domInteractive	15	108	43	23	11

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 2.32 KiB (0.06%)
ui: 182 Bytes (0.00%)
common: 201 Bytes (0.00%)

OGPoyraz added 3 commits September 6, 2024 13:24

Temp

9dbf5c3

Add Notification Display trace end

21c9bb0

Add unit test for signature util

617203e

github-actions bot added the team-confirmations Push issues to confirmations team label Sep 6, 2024

OGPoyraz marked this pull request as ready for review September 6, 2024 13:33

OGPoyraz requested review from a team as code owners September 6, 2024 13:33

Enable tracing for all type of signatures

2eae7c7

OGPoyraz force-pushed the feat/signature-performance-traces-implementation branch from eb7bb6c to 2eae7c7 Compare September 9, 2024 09:16

Merge branch 'develop' into feat/signature-performance-traces-impleme…

39b93e1

…ntation

matthewwalsh0 requested changes Sep 9, 2024

View reviewed changes

OGPoyraz added 2 commits September 10, 2024 09:41

Fix suggestions

b09d425

remove unused import

7c0a741

matthewwalsh0 requested changes Sep 14, 2024

View reviewed changes

app/scripts/lib/createTracingMiddleware.ts Outdated Show resolved Hide resolved

app/scripts/metamask-controller.js Outdated Show resolved Hide resolved

app/scripts/lib/signature/util.ts Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

OGPoyraz added 2 commits September 16, 2024 11:57

Fix suggestions

b5528fe

Merge branch 'develop' into feat/signature-performance-traces-impleme…

5a68eff

…ntation

OGPoyraz added 9 commits September 17, 2024 09:47

Update dependencies

b42e389

dedupe

20c3d7e

Update test

bfda177

Fix lint

f91ed1d

Fix unit test

0d7eea2

Fix ppom test

c59d0e6

fix mmi-build

9097c62

Merge branch 'develop' into feat/signature-performance-traces-impleme…

905ab08

…ntation

Merge branch 'develop' into feat/signature-performance-traces-impleme…

5cc0021

…ntation

Merge branch 'develop' into feat/signature-performance-traces-impleme…

0bf8712

…ntation

OGPoyraz force-pushed the feat/signature-performance-traces-implementation branch from c8c1757 to 0bf8712 Compare September 19, 2024 11:13

Merge branch 'develop' into feat/signature-performance-traces-impleme…

baa6f61

…ntation

matthewwalsh0 previously approved these changes Sep 19, 2024

View reviewed changes

Merge branch 'develop' into feat/signature-performance-traces-impleme…

dde207e

…ntation

OGPoyraz dismissed matthewwalsh0’s stale review via dde207e September 23, 2024 07:54

Fix tests

2d743ac

matthewwalsh0 previously approved these changes Sep 24, 2024

View reviewed changes

vinistevam reviewed Sep 24, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

Update package.json

f08fdb2

Co-authored-by: Vinicius Stevam <[email protected]>

OGPoyraz dismissed matthewwalsh0’s stale review via f08fdb2 September 24, 2024 13:52

vinistevam previously approved these changes Sep 24, 2024

View reviewed changes

Add callback

8edcb4d

OGPoyraz dismissed vinistevam’s stale review via 8edcb4d September 26, 2024 08:04

Merge branch 'develop' into feat/signature-performance-traces-impleme…

5ccb223

…ntation

pedronfigueiredo approved these changes Sep 26, 2024

View reviewed changes

vinistevam approved these changes Sep 26, 2024

View reviewed changes

OGPoyraz merged commit f36a831 into develop Sep 26, 2024
76 of 77 checks passed

OGPoyraz deleted the feat/signature-performance-traces-implementation branch September 26, 2024 10:12

github-actions bot locked and limited conversation to collaborators Sep 26, 2024

metamaskbot added the release-12.6.0 Issue or pull request that will be included in release 12.6.0 label Sep 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add performance metrics for signature requests #26967

feat: Add performance metrics for signature requests #26967

OGPoyraz commented Sep 6, 2024 •

edited

Loading

socket-security bot commented Sep 6, 2024 •

edited

Loading

socket-security bot commented Sep 17, 2024 •

edited

Loading

sonarqubecloud bot commented Sep 18, 2024

metamaskbot commented Sep 23, 2024

metamaskbot commented Sep 24, 2024

sonarqubecloud bot commented Sep 26, 2024

metamaskbot commented Sep 26, 2024

feat: Add performance metrics for signature requests #26967

feat: Add performance metrics for signature requests #26967

Conversation

OGPoyraz commented Sep 6, 2024 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

socket-security bot commented Sep 6, 2024 • edited Loading

socket-security bot commented Sep 17, 2024 • edited Loading

sonarqubecloud bot commented Sep 18, 2024

Quality Gate passed

metamaskbot commented Sep 23, 2024

metamaskbot commented Sep 24, 2024

sonarqubecloud bot commented Sep 26, 2024

Quality Gate failed

metamaskbot commented Sep 26, 2024

OGPoyraz commented Sep 6, 2024 •

edited

Loading

socket-security bot commented Sep 6, 2024 •

edited

Loading

socket-security bot commented Sep 17, 2024 •

edited

Loading